GET api/financial/creditcard/GetCreditCards?idList[0]={idList[0]}&idList[1]={idList[1]}&vaultCategoryType={vaultCategoryType}&includeDeleted={includeDeleted}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
idList

Collection of integer

Required

vaultCategoryType

CreditCardVaultCategoryType

Required

includeDeleted

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

WebMethodResultOfListOfCreditCard
NameDescriptionTypeAdditional information
Result

Collection of CreditCard

None.

Success

boolean

None.

ErrorText

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": [
    null,
    {
      "ID": 1,
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "NumberLastFour": "sample string 4",
      "ExpirationAsString": "2024-05-07",
      "Address": {
        "ID": 0,
        "AddressLine1": null,
        "AddressLine2": null,
        "AddressLine3": null,
        "AddressLine4": null,
        "AddressLine5": null,
        "City": null,
        "County": null,
        "StateProvince": null,
        "StateProvinceID": null,
        "PostalCode": null,
        "Country": null
      },
      "CreditCardType": 0,
      "IsDefault": false,
      "IsDeleted": false,
      "VaultID": null,
      "Gateway": 0,
      "DebitCreditTypeId": null,
      "CreditCardGatewayCategoryID": 0,
      "Email": null,
      "Number": null,
      "BIN": null,
      "MaxRefund": 0.0,
      "TokenID": null,
      "PersonID": 0,
      "Active": false,
      "ObjectID": 0,
      "IsModified": false,
      "SplitPayAccount": null,
      "SplitPayAmount": 0,
      "ObfuscatedNumber": ""
    }
  ],
  "Success": true,
  "ErrorText": "sample string 2"
}

application/javascript

Sample:
{"Result":[null,{"ID":1,"FirstName":"sample string 2","LastName":"sample string 3","NumberLastFour":"sample string 4","ExpirationAsString":"2024-05-07","Address":{"ID":0,"AddressLine1":null,"AddressLine2":null,"AddressLine3":null,"AddressLine4":null,"AddressLine5":null,"City":null,"County":null,"StateProvince":null,"StateProvinceID":null,"PostalCode":null,"Country":null},"CreditCardType":0,"IsDefault":false,"IsDeleted":false,"VaultID":null,"Gateway":0,"DebitCreditTypeId":null,"CreditCardGatewayCategoryID":0,"Email":null,"Number":null,"BIN":null,"MaxRefund":0.0,"TokenID":null,"PersonID":0,"Active":false,"ObjectID":0,"IsModified":false,"SplitPayAccount":null,"SplitPayAmount":0,"ObfuscatedNumber":""}],"Success":true,"ErrorText":"sample string 2"}

application/xml, text/xml

Sample:
<WebMethodResultOfListOfCreditCard xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Success>true</Success>
  <ErrorText>sample string 2</ErrorText>
  <Result>
    <CreditCard xsi:nil="true" />
    <CreditCard>
      <ID>1</ID>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 3</LastName>
      <NumberLastFour>sample string 4</NumberLastFour>
      <Expiration>2024-05-06T23:47:57.4302934-06:00</Expiration>
      <ExpirationAsString>2024-05-07</ExpirationAsString>
      <Address>
        <ID>0</ID>
        <StateProvinceID xsi:nil="true" />
      </Address>
      <CreditCardType>Undefined</CreditCardType>
      <IsDefault>false</IsDefault>
      <IsDeleted>false</IsDeleted>
      <Gateway>Undefined</Gateway>
      <DebitCreditTypeId xsi:nil="true" />
      <DebitCreditType>Unknown</DebitCreditType>
      <CreditCardGatewayCategoryID>0</CreditCardGatewayCategoryID>
      <VaultCategoryType>Undefined</VaultCategoryType>
      <MaxRefund>0</MaxRefund>
      <ClientId>0</ClientId>
      <PersonID>0</PersonID>
      <Active>false</Active>
      <ObjectID>0</ObjectID>
      <IsModified>false</IsModified>
      <SplitPayAmount>0</SplitPayAmount>
      <ObfuscatedNumber />
    </CreditCard>
  </Result>
</WebMethodResultOfListOfCreditCard>